lib/repo: Fix minor mistake in locking docs
authorMatthew Leeds <matthew.leeds@endlessm.com>
Fri, 28 Sep 2018 01:29:30 +0000 (18:29 -0700)
committerAtomic Bot <atomic-devel@projectatomic.io>
Fri, 28 Sep 2018 15:49:11 +0000 (15:49 +0000)
The config option is "lock-timeout-secs" not "lock-timeout".

Closes: #1737
Approved by: jlebon

src/libostree/ostree-repo.c

index 19f715aa6a4361603b3f7c68e2e7daeff57f8eb9..73ee027c5746bb0757a0d9943b8a363b00d959a4 100644 (file)
@@ -454,9 +454,9 @@ pop_repo_lock (OstreeRepo  *self,
  * state is not changed and the stack is simply updated.
  *
  * ostree_repo_lock_push() waits for the lock depending on the repository's
- * lock-timeout configuration. When lock-timeout is -1, a blocking lock is
+ * lock-timeout-secs configuration. When lock-timeout-secs is -1, a blocking lock is
  * attempted. Otherwise, the lock is taken non-blocking and
- * ostree_repo_lock_push() will sleep synchronously up to lock-timeout seconds
+ * ostree_repo_lock_push() will sleep synchronously up to lock-timeout-secs seconds
  * attempting to acquire the lock. If the lock cannot be acquired within the
  * timeout, a %G_IO_ERROR_WOULD_BLOCK error is returned.
  *
@@ -544,9 +544,9 @@ _ostree_repo_lock_push (OstreeRepo          *self,
  * lock.
  *
  * ostree_repo_lock_pop() waits for the lock depending on the repository's
- * lock-timeout configuration. When lock-timeout is -1, a blocking lock is
+ * lock-timeout-secs configuration. When lock-timeout-secs is -1, a blocking lock is
  * attempted. Otherwise, the lock is removed non-blocking and
- * ostree_repo_lock_pop() will sleep synchronously up to lock-timeout seconds
+ * ostree_repo_lock_pop() will sleep synchronously up to lock-timeout-secs seconds
  * attempting to remove the lock. If the lock cannot be removed within the
  * timeout, a %G_IO_ERROR_WOULD_BLOCK error is returned.
  *